home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / pcboard / hb_ec21.zip / CNFN.DOC < prev    next >
Text File  |  1996-01-03  |  13KB  |  315 lines
  1. Has been compiled with PPLC 3.2 so requires PCBoard 15.22+.
  2.  
  3. This was originally a small PPE written by someone at Clark Development
  4. for use on Salt Air. I have pretty much re-wrote everything but there
  5. are still traces of documentation, so credit is still due
  6. to the original author. Thanks CDC.
  7.  
  8. =============================================================================
  9.                                 CNFN.PPE
  10.  
  11. A PPE designed to build a conference join menu on-the-fly.  It checks the
  12. user's access (security) level and compares the security level to the
  13. conference's required security, whether its public or private, and if the
  14. caller is registered.  It will only display the conference the caller is
  15. allowed to join.
  16.  
  17. NEW! ENHANCED!
  18.         You can now define Conference number blocks via a CNFN.CFG file that
  19. must exist in the same directory as the PPE. This allows callers to view a
  20. subset of the conferences available (for example, one network). I added this
  21. capability because a I had a large block of conference numbers between two
  22. nets reserved for future expansion, (300 empty conferences) and this caused
  23. considerable waits for the user while the original PPE scanned through those
  24. empty conferences. Of course, you can also define a block for ALL conferences
  25. as the blocks can overlap.
  26.         Also, any or all of the blacks can also display the conferences that
  27. the user DOESN'T have access to as well (in an alternate color). This is great
  28. for subscription boards so that you can give them a "sneak preview" of what
  29. they are missing out on!!
  30.         You can also use a new security feature to limit the display of
  31. selected blocks by security, with the option to still display available
  32. conferences if you have users that you manually registered.
  33.         A caller can also search for specific text in conference names by
  34. entering S at the conference block prompt. The search is not case-sensitive.
  35.         Finally, all the colors are configurable, and you can set the number
  36. of columns to display, from 1 to 9.
  37.  
  38. =============================================================================
  39. TO INSTALL:
  40.  
  41.   Just make sure your conference join menu (defined in PCBSetup:File
  42.   Locations:Display Files) is named CNFN.  If it's not, you can either
  43.   rename this PPE or you can change the entry in PCBSetup.  Either one will
  44.   work.  Put the CNFN.PPE file into the subdirectory defined for your
  45.   conference join menu.  That's all there is to it.  You don't have to
  46.   enter it into your CMD.LST or anything else.  It will act as the
  47.   "default" menu for your system.  Instead of the CNFN file being
  48.   displayed, the PPE will execute.
  49.  
  50.   You might want to place the PPE and accompanying files in a separate
  51.   directory and change the directory in PCBSetup to the new location.
  52.  
  53. NEW! ENHANCED!
  54.  
  55. The Following files must also exist in the same directory. You can
  56. use the defaults or edit your own. An example is given with discriptions
  57. of each:
  58.  
  59. CNFN.CFG       <--Conference Info Configuration
  60. CNFN.CNF       <--PPE specific Configuration
  61. CNTEXT         <--Prompt strings file
  62. VER.ID         <--PPE version number file.
  63. 3 display files - see CNF file description for details
  64.  
  65.  
  66. =============================================================================
  67.                               CNFN.CFG
  68.  
  69.   Edit (or create) the CNFN.CFG file in the same directory as the ppe. An
  70. example would be:
  71. ;-----------------
  72. 3
  73. Local
  74. 0-10;25;50-99
  75.  
  76. N
  77. Y
  78. FidoNet
  79. 100-10000
  80.  
  81. 50
  82. Y
  83. All Conferences
  84. 0-10000
  85.  
  86. N
  87. Y
  88. ;------------------
  89.  
  90. Line 1: The number of conference blocks
  91. Line 2: The displayed name of the first block
  92. *Line 3: The conference numbers in this block
  93. Line 4: Unused but must be present. Leave Blank
  94. Line 5: Security Level for block to display. set to 'N' or 0 for no limits
  95.         Entry must exist but is only used if security option is set in
  96.         the separate CNFN.CNF file
  97. Line 6: Whether to display unavailable conferences to caller (in alternate
  98.         color). Y or N.
  99. Repeat lines 2-6 for each block
  100.  
  101.  
  102. *This line has changed in version 2.1 - Multiple Individual Conferences and
  103.         ranges can be intermixed. Ranges must have a beginning and ending
  104.         value separated by a dash (-), and each entry must be separated
  105.         by a space or semi-colon.  I don't know the effective limit to
  106.         entries for this line; whatever limits PCBoard have on Tokenized
  107.         statements...
  108.         This will allow you to have non-contiguous conferences in blocks
  109.  
  110.  
  111. If the config file is missing, then the PPE will show one option:
  112. "all conferences", and not display unavailable confs.
  113.  
  114. =============================================================================
  115.                               CNFN.CNF
  116.  
  117. Edit (or Create) the CNFN.CNF file and put it in the same directory as
  118. the PPE. Here is an example and a description:
  119.  
  120. ------------------Top of File---------
  121. CH
  122. CBH
  123. N
  124. N
  125. CBL
  126. 2
  127. L
  128.  
  129. -----------------End of File-----------
  130.  
  131.  
  132. Line 1 - Header Display file displayed before PPE displays the available
  133.          conference blocks. Can have Security, Graphic, and Language
  134.          specific files as well.
  135.  
  136. Line 2 - Header Display File displayed before available conferences are
  137.          listed, once the person makes their choice. This may have Security,
  138.          graphic, and Language specific versions of the file as well.
  139.  
  140. Line 3 - Y or N - Use the Security level feature?
  141.          If set to Y, the PPE will check the caller's security and compare
  142.          it to the security entry for the conference block they choose. If
  143.          they don't have enough security (see line 4 for exception) then
  144.          they won't be allowed to see the conference list for that block.
  145.          Instead they will be told they don't have access and return to
  146.          the conference block list to choose another block.
  147.  
  148. Line 4 - Y or N - Check block for user being registered in conferences before
  149.           displaying "insufficient security" message. If the user doesn't
  150.           have enough security for the chosen block, but they are registered
  151.           in one or more of the conferences, if this is set to yes, they
  152.           will have the list of conferences they are registered in.
  153.           NOTE - This option will slow down the display somewhat, as each
  154.           conference in the block must be checked to see if the user is
  155.           registered in any of the conferences before deciding whether
  156.           to display a conference list. I have attempted to make the
  157.           scan as fast as possible to reduce waiting time. The delay
  158.           will only affect callers with insufficient security for a block
  159.           and should only be a second or two.
  160.  
  161. Line 5 - Conference Block Lockout Display File. Displayed if the security
  162.           level feature is enabled and the users security isn't high
  163.           enough for the selected block of conferences (***Line 4 can
  164.           override this if the user is registered in a conference and line
  165.           4 is 'Y'). This file can have Security, Graphic, and Language
  166.           specific variations.
  167.  
  168. Line 6 - Number of Columns. Can range from 1 to 9 but I wouldn't
  169.           recommend going above 3 or 4. Width of the columns decreases
  170.           rapidly with each additional column. For example, with a setting
  171.           of 9, you would only get 3 characters of a conference name
  172.           displayed in each column!
  173.  
  174. Line 7 - Either L or R. Sets which part of the conference name will be
  175.           displayed if it is too long to fit in the column. Setting this
  176.           to R would be especially handy for long Internet conference
  177.           names.
  178.  
  179.  
  180. ALL Files MUST exist...
  181.  
  182. =============================================================================
  183.                               CNTEXT
  184.  
  185. This is the Prompt file used by the PPE. Each prompt is on a separate
  186. line. This file can have language specific versions. Here is a sample file:
  187.  
  188. ---------
  189. An ERROR occurred in CNFN.PPE! Notify the sysop immediately please!
  190. Which Set of conferences do you want displayed
  191. Invalid Choice, enter a valid #
  192. You do not have access to this block of conferences!
  193. Which set of conferences to search for text
  194. ---------
  195.  
  196. Line 1 - This is the Error prompt displayed to a caller if the PPE
  197.          aborts due to not being able to find a file. The specific
  198.          problem will be logged in the caller's Log.
  199.          78 char. max
  200.  
  201. Line 2 - Prompt for which block of conferences the caller wants to
  202.          display.
  203.          60 char. max
  204.  
  205. Line 3 - Displayed if the caller enters an invalid block selection.
  206.          78 char. max
  207.  
  208. Line 4 - This prompt is NOT USED at present, but must be present in the file.
  209.  
  210. Line 5 - Displayed if caller enters 'S' to search for specific text
  211.          in conference names.
  212.  
  213.  
  214. =============================================================================
  215.                               VER.ID
  216.  
  217. This is the Version Number ID file. For CNFN.PPE, it isn't currently used.
  218. I am just preparing for future ideas floating around in my head. It must exist
  219. in the PPE directory.
  220.  
  221.  
  222. =============================================================================
  223.                               CNALT
  224.  
  225. This is an alternate Block List display file. If it exists in the PPE
  226. directory, it will be displayed INSTEAD of the regular available block
  227. List. If you add or remove Conference Blocks, and are using this file,
  228. make sure you edit it to reflect the changes.
  229. This file can only have Language variations at present.
  230.  
  231. =============================================================================
  232.                              COLOR.CNF
  233.  
  234. With this optional file, you can modify the color of just about everything.
  235. If it exists, the color values will be taken from it. The first 16 lines
  236. must be the color definitions (with the full @X designation).
  237.  
  238. Here is a sample (and the defaults if the file doesn't exist):
  239. @X1A
  240. @X1C
  241. @X07
  242. @X0A
  243. @X0A
  244. @X0F
  245. @X07
  246. @X0E
  247. @X0E
  248. @X0E
  249. @X0E
  250. @X0F
  251. @X07
  252. @X07
  253. @X06
  254. @X06
  255.  
  256. ===============
  257. Color Configuration file - The above entries MUST all exist if this file
  258. exists. The entries are as follows:
  259. 1: Progress Indicator Color 1
  260. 2: Progress Indicator Color 2
  261. 3: Progress Indicator Color Reset - Used after indicator
  262. 4: Block number color
  263. 5: Block number separator color
  264. 6: Block Text color
  265. 7: Block color Reset - Used after Text
  266. 8: Block Prompt Color
  267. 9: Search Prompt Color
  268. 10: Conference Number Color
  269. 11: Conference number Separator Color
  270. 12: Conference name color
  271. 13: Conference color Reset - Used after Conference/Unavailable conf name
  272. 14: Unavailable Conf # color
  273. 15: Unavailable Conf Separator Color
  274. 16: Unavailable Conf name color
  275.  
  276.  
  277. The Reset values aren't significant unless you are using acolored background.
  278. These will ensure that the proper background is restored after each item is
  279. displayed.
  280.  
  281. =============================================================================
  282.                           FINAL IMPORTANT NOTES
  283.  
  284. Be sure that all the files exist and are in the same directory as the PPE.
  285.  
  286. For installation, my advice would be to put the ppe in it's own directory
  287. (as I have done), like C:\PPE\CNFN\ , and change PCBSETUP-File Locations
  288. to reflect the new location. By default, PCBoard tends to lump stuff in the
  289. MAIN and GEN directories, making them extremely cluttered. My method will
  290. make finding and updating easier in the future, and will keep those
  291. directories less cluttered.
  292.  
  293. The Security feature should be thought out. If you use it, you may not
  294. want to use an All Conferences block (think about it <g>) Also, I don't
  295. know how the "registered override" option will work with Conference
  296. Sysops. Make sure that they also have the R flag set in their
  297. users record to ensure this option works correctly for them.
  298.  
  299. If you find something goofy, LET ME KNOW!!! so I can fix it.
  300.  
  301.  
  302. I can be reached in the following ways:
  303.  
  304. Herbert Bushong
  305. Blackbeard's BBS - (318)-468-3385 USR DS v.34 33.6kbps
  306. Intelec          - PCBoard, PPL, CDCSupport, Admin conferences
  307. U'NI-net         - Sysops, CDCSupport, Admin, Letter_Box Conferences
  308. FidoNet          - 1:19/19
  309. Internet         - herbert.bushong@bbread.pecan.com
  310.  
  311. Newest updates can be obtained via the following methods:
  312. FREQ'd with the Magic Name ECNFN
  313. Log on to my BBS and Join Conf #5.
  314. Files are also uploaded to Salt Air.
  315.